
/*
 * Wi-Fi Protected Setup - message definitions
 * Copyright (c) 2008, Jouni Malinen <j@w1.fi>
 *
 * This software may be distributed under the terms of the BSD license.
 * See README for more details.
 */

#ifndef WPS_DEFS_H
#define WPS_DEFS_H

#ifdef CONFIG_WPS2
#define WPS_VERSION 0x20
#else /* CONFIG_WPS2 */
#define WPS_VERSION 0x10
#endif /* CONFIG_WPS2 */

/* Diffie-Hellman 1536-bit MODP Group; RFC 3526, Group 5 */
#define WPS_DH_GROUP 			(5)

#define WPS_UUID_LEN 			(16)
#define WPS_NONCE_LEN 			(16)
#define WPS_AUTHENTICATOR_LEN 		(8)
#define WPS_AUTHKEY_LEN 		(32)
#define WPS_KEYWRAPKEY_LEN 		(16)
#define WPS_EMSK_LEN 			(32)
#define WPS_PSK_LEN 			(16)
#define WPS_SECRET_NONCE_LEN 		(16)
#define WPS_HASH_LEN 			(32)
#define WPS_KWA_LEN 			(8)
#define WPS_MGMTAUTHKEY_LEN 		(32)
#define WPS_MGMTENCKEY_LEN 		(16)
#define WPS_MGMT_KEY_ID_LEN 		(16)
#define WPS_OOB_DEVICE_PASSWORD_MIN_LEN (16)
#define WPS_OOB_DEVICE_PASSWORD_LEN 	(32)
#define WPS_OOB_PUBKEY_HASH_LEN 	(20)

/* Attribute Types */
enum wps_attribute {
	ATTR_AP_CHANNEL 		= 0x1001,
	ATTR_ASSOC_STATE 		= 0x1002,
	ATTR_AUTH_TYPE 			= 0x1003,
	ATTR_AUTH_TYPE_FLAGS 		= 0x1004,
	ATTR_AUTHENTICATOR 		= 0x1005,
	ATTR_CONFIG_METHODS 		= 0x1008,
	ATTR_CONFIG_ERROR 		= 0x1009,
	ATTR_CONFIRM_URL4 		= 0x100a,
	ATTR_CONFIRM_URL6 		= 0x100b,
	ATTR_CONN_TYPE 			= 0x100c,
	ATTR_CONN_TYPE_FLAGS 		= 0x100d,
	ATTR_CRED 			= 0x100e,
	ATTR_ENCR_TYPE 			= 0x100f,
	ATTR_ENCR_TYPE_FLAGS 		= 0x1010,
	ATTR_DEV_NAME 			= 0x1011,
	ATTR_DEV_PASSWORD_ID 		= 0x1012,
	ATTR_E_HASH1 			= 0x1014,
	ATTR_E_HASH2 			= 0x1015,
	ATTR_E_SNONCE1 			= 0x1016,
	ATTR_E_SNONCE2 			= 0x1017,
	ATTR_ENCR_SETTINGS 		= 0x1018,
	ATTR_ENROLLEE_NONCE 		= 0x101a,
	ATTR_FEATURE_ID 		= 0x101b,
	ATTR_IDENTITY 			= 0x101c,
	ATTR_IDENTITY_PROOF 		= 0x101d,
	ATTR_KEY_WRAP_AUTH 		= 0x101e,
	ATTR_KEY_ID 			= 0x101f,
	ATTR_MAC_ADDR 			= 0x1020,
	ATTR_MANUFACTURER 		= 0x1021,
	ATTR_MSG_TYPE 			= 0x1022,
	ATTR_MODEL_NAME 		= 0x1023,
	ATTR_MODEL_NUMBER 		= 0x1024,
	ATTR_NETWORK_INDEX 		= 0x1026,
	ATTR_NETWORK_KEY 		= 0x1027,
	ATTR_NETWORK_KEY_INDEX 		= 0x1028,
	ATTR_NEW_DEVICE_NAME 		= 0x1029,
	ATTR_NEW_PASSWORD 		= 0x102a,
	ATTR_OOB_DEVICE_PASSWORD 	= 0x102c,
	ATTR_OS_VERSION 		= 0x102d,
	ATTR_POWER_LEVEL 		= 0x102f,
	ATTR_PSK_CURRENT 		= 0x1030,
	ATTR_PSK_MAX 			= 0x1031,
	ATTR_PUBLIC_KEY 		= 0x1032,
	ATTR_RADIO_ENABLE 		= 0x1033,
	ATTR_REBOOT 			= 0x1034,
	ATTR_REGISTRAR_CURRENT 		= 0x1035,
	ATTR_REGISTRAR_ESTABLISHED 	= 0x1036,
	ATTR_REGISTRAR_LIST 		= 0x1037,
	ATTR_REGISTRAR_MAX 		= 0x1038,
	ATTR_REGISTRAR_NONCE 		= 0x1039,
	ATTR_REQUEST_TYPE 		= 0x103a,
	ATTR_RESPONSE_TYPE 		= 0x103b,
	ATTR_RF_BANDS 			= 0x103c,
	ATTR_R_HASH1 			= 0x103d,
	ATTR_R_HASH2 			= 0x103e,
	ATTR_R_SNONCE1 			= 0x103f,
	ATTR_R_SNONCE2 			= 0x1040,
	ATTR_SELECTED_REGISTRAR 	= 0x1041,
	ATTR_SERIAL_NUMBER 		= 0x1042,
	ATTR_WPS_STATE 			= 0x1044,
	ATTR_SSID 			= 0x1045,
	ATTR_TOTAL_NETWORKS 		= 0x1046,
	ATTR_UUID_E 			= 0x1047,
	ATTR_UUID_R 			= 0x1048,
	ATTR_VENDOR_EXT 		= 0x1049,
	ATTR_VERSION 			= 0x104a,
	ATTR_X509_CERT_REQ 		= 0x104b,
	ATTR_X509_CERT 			= 0x104c,
	ATTR_EAP_IDENTITY 		= 0x104d,
	ATTR_MSG_COUNTER 		= 0x104e,
	ATTR_PUBKEY_HASH 		= 0x104f,
	ATTR_REKEY_KEY 			= 0x1050,
	ATTR_KEY_LIFETIME 		= 0x1051,
	ATTR_PERMITTED_CFG_METHODS 	= 0x1052,
	ATTR_SELECTED_REGISTRAR_CONFIG_METHODS = 0x1053,
	ATTR_PRIMARY_DEV_TYPE 		= 0x1054,
	ATTR_SECONDARY_DEV_TYPE_LIST 	= 0x1055,
	ATTR_PORTABLE_DEV 		= 0x1056,
	ATTR_AP_SETUP_LOCKED 		= 0x1057,
	ATTR_APPLICATION_EXT 		= 0x1058,
	ATTR_EAP_TYPE 			= 0x1059,
	ATTR_IV 			= 0x1060,
	ATTR_KEY_PROVIDED_AUTO 		= 0x1061,
	ATTR_802_1X_ENABLED 		= 0x1062,
	ATTR_APPSESSIONKEY 		= 0x1063,
	ATTR_WEPTRANSMITKEY 		= 0x1064,
	ATTR_REQUESTED_DEV_TYPE 	= 0x106a,
	ATTR_EXTENSIBILITY_TEST 	= 0x10fa /* _NOT_ defined in the spec */
};

#define WPS_VENDOR_ID_WFA 14122

/* WFA Vendor Extension subelements */
enum {
	WFA_ELEM_VERSION2 		= 0x00,
	WFA_ELEM_AUTHORIZEDMACS 	= 0x01,
	WFA_ELEM_NETWORK_KEY_SHAREABLE 	= 0x02,
	WFA_ELEM_REQUEST_TO_ENROLL 	= 0x03,
	WFA_ELEM_SETTINGS_DELAY_TIME 	= 0x04
};

/* Device Password ID */
enum wps_dev_password_id {
	DEV_PW_DEFAULT 			= 0x0000,
	DEV_PW_USER_SPECIFIED 		= 0x0001,
	DEV_PW_MACHINE_SPECIFIED	= 0x0002,
	DEV_PW_REKEY 			= 0x0003,
	DEV_PW_PUSHBUTTON 		= 0x0004,
	DEV_PW_REGISTRAR_SPECIFIED 	= 0x0005
};

/* Message Type */
enum wps_msg_type {
	WPS_START		= 0x00,
	WPS_Beacon 		= 0x01,
	WPS_ProbeRequest 	= 0x02,
	WPS_ProbeResponse 	= 0x03,
	WPS_M1 			= 0x04,
	WPS_M2 			= 0x05,
	WPS_M2D 		= 0x06,
	WPS_M3 			= 0x07,
	WPS_M4 			= 0x08,
	WPS_M5 			= 0x09,
	WPS_M6 			= 0x0a,
	WPS_M7 			= 0x0b,
	WPS_M8 			= 0x0c,
	WPS_WSC_ACK 		= 0x0d,
	WPS_WSC_NACK 		= 0x0e,
	WPS_WSC_DONE 		= 0x0f
};

/* Authentication Type Flags */
#define WPS_AUTH_OPEN 		0x0001
#define WPS_AUTH_WPAPSK 	0x0002
#define WPS_AUTH_SHARED 	0x0004
#define WPS_AUTH_WPA 		0x0008
#define WPS_AUTH_WPA2 		0x0010
#define WPS_AUTH_WPA2PSK 	0x0020
#define WPS_AUTH_TYPES (WPS_AUTH_OPEN | WPS_AUTH_WPAPSK | WPS_AUTH_SHARED | \
			WPS_AUTH_WPA | WPS_AUTH_WPA2 | WPS_AUTH_WPA2PSK)

/* Encryption Type Flags */
#define WPS_ENCR_NONE 	0x0001
#define WPS_ENCR_WEP 	0x0002
#define WPS_ENCR_TKIP 	0x0004
#define WPS_ENCR_AES 	0x0008
#define WPS_ENCR_TYPES (WPS_ENCR_NONE | WPS_ENCR_WEP | WPS_ENCR_TKIP | \
			WPS_ENCR_AES)

/* Configuration Error */
enum wps_config_error {
	WPS_CFG_NO_ERROR 		= 0,
	WPS_CFG_OOB_IFACE_READ_ERROR 	= 1,
	WPS_CFG_DECRYPTION_CRC_FAILURE 	= 2,
	WPS_CFG_24_CHAN_NOT_SUPPORTED 	= 3,
	WPS_CFG_50_CHAN_NOT_SUPPORTED 	= 4,
	WPS_CFG_SIGNAL_TOO_WEAK 	= 5,
	WPS_CFG_NETWORK_AUTH_FAILURE 	= 6,
	WPS_CFG_NETWORK_ASSOC_FAILURE 	= 7,
	WPS_CFG_NO_DHCP_RESPONSE 	= 8,
	WPS_CFG_FAILED_DHCP_CONFIG 	= 9,
	WPS_CFG_IP_ADDR_CONFLICT 	= 10,
	WPS_CFG_NO_CONN_TO_REGISTRAR 	= 11,
	WPS_CFG_MULTIPLE_PBC_DETECTED 	= 12,
	WPS_CFG_ROGUE_SUSPECTED 	= 13,
	WPS_CFG_DEVICE_BUSY 		= 14,
	WPS_CFG_SETUP_LOCKED 		= 15,
	WPS_CFG_MSG_TIMEOUT 		= 16,
	WPS_CFG_REG_SESS_TIMEOUT 	= 17,
	WPS_CFG_DEV_PASSWORD_AUTH_FAILURE = 18
};

/* RF Bands */
#define WPS_RF_24GHZ (0x01)
#define WPS_RF_50GHZ (0x02)

/* Config Methods */
#define WPS_CONFIG_USBA 		(0x0001)
#define WPS_CONFIG_ETHERNET 		(0x0002)
#define WPS_CONFIG_LABEL 		(0x0004)
#define WPS_CONFIG_DISPLAY 		(0x0008)
#define WPS_CONFIG_EXT_NFC_TOKEN 	(0x0010)
#define WPS_CONFIG_INT_NFC_TOKEN 	(0x0020)
#define WPS_CONFIG_NFC_INTERFACE 	(0x0040)
#define WPS_CONFIG_PUSHBUTTON 		(0x0080)
#define WPS_CONFIG_KEYPAD 		(0x0100)

#ifdef CONFIG_WPS2
#define WPS_CONFIG_VIRT_PUSHBUTTON 	(0x0280)
#define WPS_CONFIG_PHY_PUSHBUTTON 	(0x0480)
#define WPS_CONFIG_VIRT_DISPLAY 	(0x2008)
#define WPS_CONFIG_PHY_DISPLAY 		(0x4008)
#endif /* CONFIG_WPS2 */

/* Connection Type Flags */
#define WPS_CONN_ESS 			(0x01)
#define WPS_CONN_IBSS 			(0x02)

/* Wi-Fi Protected Setup State */
enum wps_state {
	WPS_STATE_NOT_CONFIGURED 	= 1,
	WPS_STATE_CONFIGURED 		= 2
};

/* Association State */
enum wps_assoc_state {
	WPS_ASSOC_NOT_ASSOC 	= 0,
	WPS_ASSOC_CONN_SUCCESS 	= 1,
	WPS_ASSOC_CFG_FAILURE 	= 2,
	WPS_ASSOC_FAILURE 	= 3,
	WPS_ASSOC_IP_FAILURE 	= 4
};


#define WPS_DEV_OUI_WFA 	(0x0050f204)

enum wps_dev_categ {
	WPS_DEV_COMPUTER 	= 1,
	WPS_DEV_INPUT 		= 2,
	WPS_DEV_PRINTER 	= 3,
	WPS_DEV_CAMERA 		= 4,
	WPS_DEV_STORAGE 	= 5,
	WPS_DEV_NETWORK_INFRA 	= 6,
	WPS_DEV_DISPLAY 	= 7,
	WPS_DEV_MULTIMEDIA 	= 8,
	WPS_DEV_GAMING 		= 9,
	WPS_DEV_PHONE 		= 10
};

enum wps_dev_subcateg {
	WPS_DEV_COMPUTER_PC 			= 1,
	WPS_DEV_COMPUTER_SERVER 		= 2,
	WPS_DEV_COMPUTER_MEDIA_CENTER 		= 3,
	
	WPS_DEV_PRINTER_PRINTER 		= 1,
	WPS_DEV_PRINTER_SCANNER 		= 2,
	
	WPS_DEV_CAMERA_DIGITAL_STILL_CAMERA 	= 1,
	
	WPS_DEV_STORAGE_NAS 			= 1,
	
	WPS_DEV_NETWORK_INFRA_AP 		= 1,
	WPS_DEV_NETWORK_INFRA_ROUTER 		= 2,
	WPS_DEV_NETWORK_INFRA_SWITCH 		= 3,
	
	WPS_DEV_DISPLAY_TV 			= 1,
	WPS_DEV_DISPLAY_PICTURE_FRAME 		= 2,
	WPS_DEV_DISPLAY_PROJECTOR 		= 3,
	
	WPS_DEV_MULTIMEDIA_DAR 			= 1,
	WPS_DEV_MULTIMEDIA_PVR 			= 2,
	WPS_DEV_MULTIMEDIA_MCX 			= 3,
	
	WPS_DEV_GAMING_XBOX 			= 1,
	WPS_DEV_GAMING_XBOX360 			= 2,
	WPS_DEV_GAMING_PLAYSTATION 		= 3,
	
	WPS_DEV_PHONE_WINDOWS_MOBILE 		= 1
};


/* Request Type */
enum wps_request_type {
	WPS_REQ_ENROLLEE_INFO 		= 0,
	WPS_REQ_ENROLLEE 		= 1,
	WPS_REQ_REGISTRAR 		= 2,
	WPS_REQ_WLAN_MANAGER_REGISTRAR 	= 3
};

/* Response Type */
enum wps_response_type {
	WPS_RESP_ENROLLEE_INFO 		= 0,
	WPS_RESP_ENROLLEE 		= 1,
	WPS_RESP_REGISTRAR 		= 2,
	WPS_RESP_AP 			= 3
};

/* Walk Time for push button configuration (in seconds) */
#define WPS_PBC_WALK_TIME (120)

#define WPS_MAX_AUTHORIZED_MACS (5)

#endif /* WPS_DEFS_H */

